Clarify that credentials are not required #169
Conversation
troyraen
added
documentation
jkrick
left a comment
jkrick
left a comment
There was a problem hiding this comment.
minor suggestions, thanks for working on this.
| To connect to an S3 bucket we just need to point the reader at S3 instead of the local filesystem. | ||
| (Here, a "reader" is a python library that reads parquet files.) | ||
| We'll use [pyarrow.fs.S3FileSystem](https://arrow.apache.org/docs/python/generated/pyarrow.fs.S3FileSystem.html) for this because it is recognized by every reader in examples below, and we're already using pyarrow. | ||
| [s3fs](https://s3fs.readthedocs.io/en/latest/index.html) is another common option. |
There was a problem hiding this comment.
Because it's covered in the cloud access notebook that I added a link to and I felt that it interrupted the flow of this paragraph much more than it added. Do you think it's particularly valuable here?
There was a problem hiding this comment.
not critical at all, but seemed small enough and useful enough to leave here, since many users won't follow the link.
| [s3fs](https://s3fs.readthedocs.io/en/latest/index.html) is another common option. | ||
| The call to `S3FileSystem` will look for AWS credentials in environment variables and/or the file ~/.aws/credentials. | ||
| Credentials can also be passed as keyword arguments. | ||
| To access without credentials, we'll use the keyword argument `anonymous=True`. |
There was a problem hiding this comment.
| To access without credentials, we'll use the keyword argument `anonymous=True`. | |
| To avoid an error about credentials, we'll use the keyword argument `anonymous=True`. |
There was a problem hiding this comment.
What's the motivation for saying the argument helps avoid an error? The same could be said for most arguments. Rereading what I changed above, I see that this mirrors the "To avoid this" that I put in the other notebook. It makes it sound like the keyword argument is a workaround for some problem, but a lack of credentials isn't a problem. Maybe I'll change that a bit to phrase it more positively.
There was a problem hiding this comment.
not super important, I just thought we should justify the keyword argument as being associated with not needing credentials, and I assume people won't read all the text, so repetition seems appropriate.
Clarify that credentials are not required 252f6df
Text in the AllWISE parquet notebook makes it sound like AWS credentials are required, which they're not. This PR corrects that and also improves related languaging in the cloud access intro notebook. It also changes the AllWISE ODR link to point directly to the wise-allwise page (which didn't exist yet when the notebook was written) and removes a "Terminology" heading since the word tends to scare people off and the heading isn't necessary here anyway.